home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmDropTransfer.z / XmDropTransfer
Encoding:
Text File  |  2002-10-03  |  12.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr - The DropTransfer widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/DragDrop.h>
  13.  
  14.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  15.           This page documents Motif 2.1.
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           DropTransfer provides a set of resources that identifies the
  19.           procedures and associated information required by the
  20.           toolkit in order to process and complete a drop transaction.
  21.           Clients should not explicitly create a DropTransfer widget.
  22.           Instead, a client initiates a transfer by calling
  23.           XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt, which initializes and returns a
  24.           DropTransfer widget. If this function is called within an
  25.           XXXXmmmmNNNNddddrrrrooooppppPPPPrrrroooocccc callback, the actual transfers are initiated
  26.           after the callback returns. Even if no data needs to be
  27.           transferred, XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt needs to be called
  28.           (typically with no arguments, or just setting
  29.           XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss) to finish the drag and drop transaction.
  30.  
  31.           The XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss resource specifies a transfer list that
  32.           describes the requested target types for the source data. A
  33.           transfer list is an array of
  34.           XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeeccccstructures, each of which identifies a
  35.           target type. The transfer list is analogous to the MULTIPLE
  36.           selections capability defined in the _I_n_t_e_r-_C_l_i_e_n_t
  37.           _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l(ICCCM).
  38.  
  39.           The DropTransfer resource, XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrPPPPrrrroooocccc, specifies a
  40.           transfer procedure of type XtSelectionCallbackProc that
  41.           delivers the requested selection data. This procedure
  42.           operates in conjunction with the underlying Xt selection
  43.           capabilities and is called for each target in the transfer
  44.           list. Additional target types can be requested after a
  45.           transfer is initiated by calling the XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrAAAAdddddddd
  46.           function.
  47.  
  48.         SSSSttttrrrruuuuccccttttuuuurrrreeeessss
  49.           An XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyy is a pointer to the following
  50.           structure of type XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeecccc, which identifies a
  51.           selection target associated with a given drop transaction:
  52.  
  53.           typedef struct
  54.           {
  55.                   XtPointer       _c_l_i_e_n_t__d_a_t_a;;;;
  56.                   AAAAttttoooommmm _t_a_r_g_e_t;;;;
  57.           }}}} XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeecccc,,,, ****XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyy;;;;
  58.  
  59.           _c_l_i_e_n_t__d_a_t_a
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     Specifies any additional information required by
  75.                     this selection target
  76.  
  77.           _t_a_r_g_e_t    Specifies a selection target associated with the
  78.                     drop operation
  79.  
  80.         CCCCllllaaaasssssssseeeessss
  81.           DropTransfer inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.
  82.  
  83.           The class pointer is _x_m_D_r_o_p_T_r_a_n_s_f_e_r_O_b_j_e_c_t_C_l_a_s_s.
  84.  
  85.           The class name is XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr.
  86.  
  87.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  88.           The following table defines a set of widget resources used
  89.           by the programmer to specify data. The programmer can also
  90.           set the resource values for the inherited classes to set
  91.           attributes for this widget. To reference a resource by name
  92.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  93.           prefix and use the remaining letters. To specify one of the
  94.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  95.           the XXXXmmmm prefix and use the remaining letters (in either
  96.           lowercase or uppercase, but include any underscores between
  97.           words). The codes in the access column indicate if the given
  98.           resource can be set at creation time (C), set by using
  99.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  100.           not applicable (N/A).
  101.  
  102.                                              XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  103.           NNNNaaaammmmeeee                  CCCCllllaaaassssssss                 TTTTyyyyppppeeee                       DDDDeeeeffffaaaauuuulllltttt              AAAAcccccccceeeessssssss
  104.           XmNdropTransfers      XmCDropTransfers      XmDropTransferEntryRec *   NULL                 CG
  105.           XmNincremental        XmCIncremental        Boolean                    False                CSG
  106.           XmNnumDropTransfers   XmCNumDropTransfers   Cardinal                   0                    CSG
  107.           XmNtransferProc       XmCTransferProc       XtSelectionCallbackProc    NULL                 CSG
  108.           XmNtransferStatus     XmCTransferStatus     unsigned char              XmTRANSFER_SUCCESS   CSG
  109.  
  110.           XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss
  111.                     Specifies the address of an array of drop transfer
  112.                     entry records. The drop transfer is complete when
  113.                     all the entries in the list have been processed.
  114.  
  115.           XXXXmmmmNNNNiiiinnnnccccrrrreeeemmmmeeeennnnttttaaaallll
  116.                     Specifies a Boolean value that indicates whether
  117.                     the transfer on the receiver side uses the Xt
  118.                     incremental selection transfer mechanism described
  119.                     in _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s-_C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e.  If
  120.                     the value is True, the receiver uses incremental
  121.                     transfer; if the value is False, the receiver uses
  122.                     atomic transfer.
  123.  
  124.           XXXXmmmmNNNNnnnnuuuummmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss
  125.                     Specifies the number of entries in
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss. If this resource is set to 0 at
  141.                     any time, the transfer is considered complete. The
  142.                     value of XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss determines the
  143.                     completion handshaking process.
  144.  
  145.           XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrPPPPrrrroooocccc
  146.                     Specifies a procedure of type
  147.                     _X_t_S_e_l_e_c_t_i_o_n_C_a_l_l_b_a_c_k_P_r_o_c that delivers the
  148.                     requested selection values.  The _w_i_d_g_e_t argument
  149.                     passed to this procedure is the DropTransfer
  150.                     widget.  The selection atom passed is _MOTIF_DROP.
  151.                     For additional information on selection callback
  152.                     procedures, see _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s-_C _L_a_n_g_u_a_g_e
  153.                     _I_n_t_e_r_f_a_c_e.
  154.  
  155.           XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss
  156.                     Specifies the current status of the drop transfer.
  157.                     The client updates this value when the transfer
  158.                     ends and communicates the value to the initiator.
  159.                     The possible values are
  160.  
  161.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____SSSSUUUUCCCCCCCCEEEESSSSSSSS
  162.                               The transfer succeeded.
  163.  
  164.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____FFFFAAAAIIIILLLLUUUURRRREEEE
  165.                               The transfer failed.
  166.  
  167.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  168.           DropTransfer inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.
  169.           For a complete description of this resource, refer to the
  170.           OOOObbbbjjjjeeeecccctttt reference page.
  171.  
  172.                                   OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  173.           NNNNaaaammmmeeee                 CCCCllllaaaassssssss         TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  174.           XmNdestroyCallback   XmCCallback   XtCallbackList   NULL      C
  175.  
  176.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  177.           OOOObbbbjjjjeeeecccctttt(3), XXXXmmmmDDDDiiiissssppppllllaaaayyyy(3), XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt(3), XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn(3),
  178.           XXXXmmmmDDDDrrrrooooppppSSSSiiiitttteeee(3), XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrAAAAdddddddd(3), and
  179.           XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt(3).
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.